STU 3 Candidate
This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
The official URL for this profile is:
http://hl7.org/fhir/StructureDefinition/sdc-questionnaire
Defines how Questionnaire is used to reflect form definitions to be used within the ONC's Structured Data Capture standard.
This profile was published on Mon, Apr 21, 2014 00:00+1000 as a draft by Health Level Seven International (Orders and Observations - Structured Data Capture).
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Questionnaire.
Summary
Mandatory: 3 elements (+2 nested mandatory elements)
Must-Support: 48 elements
Extensions
This structure refers to these extensions:
This structure is derived from Questionnaire.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Questionnaire | I | 0..* | Questionnaire | A structured set of questions que-2: The link ids for groups and questions must be unique within the questionnaire |
 meta | ∑ | 0..1 | Meta | Metadata about the resource |
 implicitRules | ?! ∑ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: IETF BCP-47  (required) | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
 sdc-questionnaire-endpoint | S | 0..* | uri | Extension URL: http://hl7.org/fhir/StructureDefinition/sdc-questionnaire-endpoint |
| sdc-questionnaire-provenanceSignatureRequred | S | 0..1 | boolean | Extension URL: http://hl7.org/fhir/StructureDefinition/sdc-questionnaire-provenanceSignatureRequred |
| styleSensitive | S | 0..1 | boolean | Extension URL: http://hl7.org/fhir/StructureDefinition/styleSensitive |
| questionnaire-deMap | 0..1 | Reference(ConceptMap) | Extension URL: http://hl7.org/fhir/StructureDefinition/questionnaire-deMap | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| url | S ∑ | 1..1 | uri | Globally unique logical identifier for questionnaire |
 identifier | S ∑ | 0..* | Identifier | External identifiers for this questionnaire |
| version | S ∑ | 0..1 | string | Logical identifier for this version of Questionnaire |
| status | ?! S∑ | 1..1 | code | draft | published | retired Binding: QuestionnaireStatus (required) |
| date | S ∑ | 1..1 | dateTime | Date this version was authored |
| publisher | S ∑ | 0..1 | string | Organization/individual who designed the questionnaire |
| telecom | ∑ | 0..* | ContactPoint | Contact information of the publisher |
| useContext | S ∑ | 0..* | CodeableConcept | Questionnaire intends to support these contexts Binding: Context of Use ValueSet (extensible) |
| title | S ∑ | 1..1 | string | Name for the questionnaire |
 style | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/style | |
| markup | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/markup | |
 value | 0..1 | Primitive value for string | ||
| concept | S ∑ | 0..1 | Coding | Concept that represents the overall questionnaire Binding: Questionnaire Question Codes (example) |
| subjectType | S ∑ | 0..* | code | Resource that can be subject of QuestionnaireResponse Binding: ResourceType (required) |
| item | S I | 0..* | BackboneElement | Questions and sections within the Questionnaire que-10: Maximum length can only be declared for simple question types que-1: Group items must have nested items, display items cannot have nested items que-3: Display items cannot have a "concept" asserted que-5: Only 'choice' items can have options que-4: A question cannot have both option and options que-6: Required and repeat aren't permitted for display items que-9: Read-only can't be specified for "display" items que-8: Default values can't be specified for groups or display items |
 questionnaire-minOccurs | S I | 0..1 | integer | Extension URL: http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs inv-3: minOccurs can't exist for display items inv-1: minOccurs can't be more than one if required is false |
| questionnaire-maxOccurs | S I | 0..1 | integer | Extension URL: http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs inv-2: maxOccurs can't be more than one if repeats is false inv-4: maxOccurs can't exist for display items |
| sdc-questionnaire-optionalDisplay | 0..1 | boolean | Extension URL: http://hl7.org/fhir/StructureDefinition/sdc-questionnaire-optionalDisplay | |
| questionnaire-hidden | S | 0..1 | boolean | Extension URL: http://hl7.org/fhir/StructureDefinition/questionnaire-hidden |
| questionnaire-itemControl | S | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl |
| questionnaire-choiceOrientation | I | 0..1 | code | Extension URL: http://hl7.org/fhir/StructureDefinition/questionnaire-choiceOrientation inv-6: choiceOrientation can only be present on elements of type "choice" or "open-choice" |
| minLength | S | 0..1 | integer | Extension URL: http://hl7.org/fhir/StructureDefinition/minLength |
| regex | S | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/regex |
| entryFormat | S | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/entryFormat |
| minValue | S | 0..1 | date, dateTime, time, instant, decimal, integer | Extension URL: http://hl7.org/fhir/StructureDefinition/minValue |
| maxValue | S | 0..1 | date, dateTime, time, instant, decimal, integer | Extension URL: http://hl7.org/fhir/StructureDefinition/maxValue |
| maxDecimalPlaces | S | 0..1 | integer | Extension URL: http://hl7.org/fhir/StructureDefinition/maxDecimalPlaces |
| mimeType | S | 0..1 | code | Extension URL: http://hl7.org/fhir/StructureDefinition/mimeType |
| maxSize | 0..1 | decimal | Extension URL: http://hl7.org/fhir/StructureDefinition/maxSize | |
| questionnaire-unit | S I | 0..1 | Coding | Extension URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unit inv-16: Lookup Questionnaire can only be specified for questions with a type of "integer" or "decimal" |
| questionnaire-deReference | S I | 0..1 | Reference(DataElement) | Extension URL: http://hl7.org/fhir/StructureDefinition/questionnaire-deReference inv-9: Data Element references can't be specified for "display" items |
| questionnaire-allowedResource | S I | 0..* | code | Extension URL: http://hl7.org/fhir/StructureDefinition/questionnaire-allowedResource inv-10: Allowed resource can only be specified for items of type 'reference' |
| questionnaire-displayCategory | S I | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/StructureDefinition/questionnaire-displayCategory inv-11: Display category can only be specified for items of type display |
| modifierExtension | ?! ∑ | 0..* | Extension | Extensions that cannot be ignored |
| linkId | S | 1..1 | string | To link questionnaire with questionnaire response |
| concept | S ∑I | 0..1 | Coding | Concept that represents this item within in a questionnaire Binding: Questionnaire Question Codes (example) |
| prefix | S | 0..1 | string | E.g. "1(a)", "2.5.3" |
| style | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/style | |
| markup | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/markup | |
| value | 0..1 | Primitive value for string | ||
| text | S ∑ | 0..1 | string | Primary text for the item |
| style | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/style | |
| markup | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/markup | |
| value | 0..1 | Primitive value for string | ||
| type | S | 1..1 | code | group | display | boolean | decimal | integer | date | dateTime + Binding: QuestionnaireItemType (required) |
| enableWhen | ?! SI | 0..* | BackboneElement | Only allow data when: que-7: enableWhen must contain either an 'answer' or an 'answered' element |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?! ∑ | 0..* | Extension | Extensions that cannot be ignored |
| question | S | 1..1 | string | Question that determines whether item is enabled |
| answered | S I | 0..1 | boolean | Enable when answered or not |
 answer[x] | S I | 0..1 | boolean, decimal, integer, date, dateTime, instant, time, string, uri, Attachment, Coding, Quantity, Reference(Resource) | Value question must have |
| required | S I | 0..1 | boolean | Whether the item must be included in data results |
| repeats | S I | 0..1 | boolean | Whether the item may repeat |
| readOnly | S I | 0..1 | boolean | Don't allow human editing |
| maxLength | S I | 0..1 | integer | No more than this many characters |
 options | S I | 0..1 | Reference(ValueSet) | Valueset containing permitted answers |
| option | S I | 0..* | BackboneElement | Permitted answer |
| questionnaire-optionPrefix | S | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/questionnaire-optionPrefix |
| modifierExtension | ?! ∑ | 0..* | Extension | Extensions that cannot be ignored |
| value[x] | S | 1..1 | integer, date, time, string, Coding | Answer value Binding: Questionnaire Answer Codes (example) |
| initial[x] | S I | 0..1 | boolean, decimal, integer, date, dateTime, instant, time, string, uri, Attachment, Coding, Quantity, Reference(Resource) | Initial presumed answer for question |
 item | S I | 0..* | Unknown reference to #item Nested questionnaire items | |
| Documentation for this format | ||||
todo
This structure is derived from Questionnaire.
Summary
Mandatory: 3 elements (+2 nested mandatory elements)
Must-Support: 48 elements
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from Questionnaire.
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Questionnaire | I | 0..* | Questionnaire | A structured set of questions que-2: The link ids for groups and questions must be unique within the questionnaire |
| meta | ∑ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?! ∑ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: IETF BCP-47 (required) | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| sdc-questionnaire-endpoint | S | 0..* | uri | Extension URL: http://hl7.org/fhir/StructureDefinition/sdc-questionnaire-endpoint |
| sdc-questionnaire-provenanceSignatureRequred | S | 0..1 | boolean | Extension URL: http://hl7.org/fhir/StructureDefinition/sdc-questionnaire-provenanceSignatureRequred |
| styleSensitive | S | 0..1 | boolean | Extension URL: http://hl7.org/fhir/StructureDefinition/styleSensitive |
| questionnaire-deMap | 0..1 | Reference(ConceptMap) | Extension URL: http://hl7.org/fhir/StructureDefinition/questionnaire-deMap | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| url | S ∑ | 1..1 | uri | Globally unique logical identifier for questionnaire |
| identifier | S ∑ | 0..* | Identifier | External identifiers for this questionnaire |
| version | S ∑ | 0..1 | string | Logical identifier for this version of Questionnaire |
| status | ?! S∑ | 1..1 | code | draft | published | retired Binding: QuestionnaireStatus (required) |
| date | S ∑ | 1..1 | dateTime | Date this version was authored |
| publisher | S ∑ | 0..1 | string | Organization/individual who designed the questionnaire |
| telecom | ∑ | 0..* | ContactPoint | Contact information of the publisher |
| useContext | S ∑ | 0..* | CodeableConcept | Questionnaire intends to support these contexts Binding: Context of Use ValueSet (extensible) |
| title | S ∑ | 1..1 | string | Name for the questionnaire |
| style | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/style | |
| markup | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/markup | |
| value | 0..1 | Primitive value for string | ||
| concept | S ∑ | 0..1 | Coding | Concept that represents the overall questionnaire Binding: Questionnaire Question Codes (example) |
| subjectType | S ∑ | 0..* | code | Resource that can be subject of QuestionnaireResponse Binding: ResourceType (required) |
| item | S I | 0..* | BackboneElement | Questions and sections within the Questionnaire que-10: Maximum length can only be declared for simple question types que-1: Group items must have nested items, display items cannot have nested items que-3: Display items cannot have a "concept" asserted que-5: Only 'choice' items can have options que-4: A question cannot have both option and options que-6: Required and repeat aren't permitted for display items que-9: Read-only can't be specified for "display" items que-8: Default values can't be specified for groups or display items |
| questionnaire-minOccurs | S I | 0..1 | integer | Extension URL: http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs inv-3: minOccurs can't exist for display items inv-1: minOccurs can't be more than one if required is false |
| questionnaire-maxOccurs | S I | 0..1 | integer | Extension URL: http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs inv-2: maxOccurs can't be more than one if repeats is false inv-4: maxOccurs can't exist for display items |
| sdc-questionnaire-optionalDisplay | 0..1 | boolean | Extension URL: http://hl7.org/fhir/StructureDefinition/sdc-questionnaire-optionalDisplay | |
| questionnaire-hidden | S | 0..1 | boolean | Extension URL: http://hl7.org/fhir/StructureDefinition/questionnaire-hidden |
| questionnaire-itemControl | S | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl |
| questionnaire-choiceOrientation | I | 0..1 | code | Extension URL: http://hl7.org/fhir/StructureDefinition/questionnaire-choiceOrientation inv-6: choiceOrientation can only be present on elements of type "choice" or "open-choice" |
| minLength | S | 0..1 | integer | Extension URL: http://hl7.org/fhir/StructureDefinition/minLength |
| regex | S | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/regex |
| entryFormat | S | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/entryFormat |
| minValue | S | 0..1 | date, dateTime, time, instant, decimal, integer | Extension URL: http://hl7.org/fhir/StructureDefinition/minValue |
| maxValue | S | 0..1 | date, dateTime, time, instant, decimal, integer | Extension URL: http://hl7.org/fhir/StructureDefinition/maxValue |
| maxDecimalPlaces | S | 0..1 | integer | Extension URL: http://hl7.org/fhir/StructureDefinition/maxDecimalPlaces |
| mimeType | S | 0..1 | code | Extension URL: http://hl7.org/fhir/StructureDefinition/mimeType |
| maxSize | 0..1 | decimal | Extension URL: http://hl7.org/fhir/StructureDefinition/maxSize | |
| questionnaire-unit | S I | 0..1 | Coding | Extension URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unit inv-16: Lookup Questionnaire can only be specified for questions with a type of "integer" or "decimal" |
| questionnaire-deReference | S I | 0..1 | Reference(DataElement) | Extension URL: http://hl7.org/fhir/StructureDefinition/questionnaire-deReference inv-9: Data Element references can't be specified for "display" items |
| questionnaire-allowedResource | S I | 0..* | code | Extension URL: http://hl7.org/fhir/StructureDefinition/questionnaire-allowedResource inv-10: Allowed resource can only be specified for items of type 'reference' |
| questionnaire-displayCategory | S I | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/StructureDefinition/questionnaire-displayCategory inv-11: Display category can only be specified for items of type display |
| modifierExtension | ?! ∑ | 0..* | Extension | Extensions that cannot be ignored |
| linkId | S | 1..1 | string | To link questionnaire with questionnaire response |
| concept | S ∑I | 0..1 | Coding | Concept that represents this item within in a questionnaire Binding: Questionnaire Question Codes (example) |
| prefix | S | 0..1 | string | E.g. "1(a)", "2.5.3" |
| style | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/style | |
| markup | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/markup | |
| value | 0..1 | Primitive value for string | ||
| text | S ∑ | 0..1 | string | Primary text for the item |
| style | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/style | |
| markup | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/markup | |
| value | 0..1 | Primitive value for string | ||
| type | S | 1..1 | code | group | display | boolean | decimal | integer | date | dateTime + Binding: QuestionnaireItemType (required) |
| enableWhen | ?! SI | 0..* | BackboneElement | Only allow data when: que-7: enableWhen must contain either an 'answer' or an 'answered' element |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?! ∑ | 0..* | Extension | Extensions that cannot be ignored |
| question | S | 1..1 | string | Question that determines whether item is enabled |
| answered | S I | 0..1 | boolean | Enable when answered or not |
| answer[x] | S I | 0..1 | boolean, decimal, integer, date, dateTime, instant, time, string, uri, Attachment, Coding, Quantity, Reference(Resource) | Value question must have |
| required | S I | 0..1 | boolean | Whether the item must be included in data results |
| repeats | S I | 0..1 | boolean | Whether the item may repeat |
| readOnly | S I | 0..1 | boolean | Don't allow human editing |
| maxLength | S I | 0..1 | integer | No more than this many characters |
| options | S I | 0..1 | Reference(ValueSet) | Valueset containing permitted answers |
| option | S I | 0..* | BackboneElement | Permitted answer |
| questionnaire-optionPrefix | S | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/questionnaire-optionPrefix |
| modifierExtension | ?! ∑ | 0..* | Extension | Extensions that cannot be ignored |
| value[x] | S | 1..1 | integer, date, time, string, Coding | Answer value Binding: Questionnaire Answer Codes (example) |
| initial[x] | S I | 0..1 | boolean, decimal, integer, date, dateTime, instant, time, string, uri, Attachment, Coding, Quantity, Reference(Resource) | Initial presumed answer for question |
| item | S I | 0..* | Unknown reference to #item Nested questionnaire items | |
| Documentation for this format | ||||
XML Template
JSON Template
todo
Other representations of profile: Schematron
| Path | Name | Conformance | ValueSet |
| Questionnaire.language | ?ext | required | http://tools.ietf.org/html/bcp47 |
| Questionnaire.status | QuestionnaireStatus | required | QuestionnaireStatus |
| Questionnaire.useContext | Context of Use ValueSet | extensible | Context of Use ValueSet |
| Questionnaire.concept | Questionnaire Question Codes | example | Questionnaire Question Codes |
| Questionnaire.subjectType | ResourceType | required | ResourceType |
| Questionnaire.item.concept | Questionnaire Question Codes | example | Questionnaire Question Codes |
| Questionnaire.item.type | QuestionnaireItemType | required | QuestionnaireItemType |
| Questionnaire.item.option.value[x] | Questionnaire Answer Codes | example | Questionnaire Answer Codes |
| Id | Path | Details | Requirements |
| que-2 | Questionnaire | The link ids for groups and questions must be unique within the questionnaire XPath: count(descendant::f:linkId/@value)=count(distinct-values(descendant::f:linkId/@value)) | |
| que-10 | Questionnaire.item | Maximum length can only be declared for simple question types XPath: f:type/@value=('boolean', 'decimal', 'integer', 'open-choice', 'string', 'text', 'url') or not(f:maxLength) | |
| que-1 | Questionnaire.item | Group items must have nested items, display items cannot have nested items XPath: not((f:type/@value='group' and not(f:item)) or (f:type/@value='display' and f:item)) | |
| que-3 | Questionnaire.item | Display items cannot have a "concept" asserted XPath: not(f:type/@value='display' and f:concept) | |
| que-5 | Questionnaire.item | Only 'choice' items can have options XPath: f:type/@value=('choice','open-choice') or not(f:option or f:options) | |
| que-4 | Questionnaire.item | A question cannot have both option and options XPath: not(f:options and f:option) | |
| que-6 | Questionnaire.item | Required and repeat aren't permitted for display items XPath: not(f:type/@value='display' and (f:required or f:repeats)) | |
| que-9 | Questionnaire.item | Read-only can't be specified for "display" items XPath: not(f:type/@value='display' and f:readOnly) | |
| que-8 | Questionnaire.item | Default values can't be specified for groups or display items XPath: not(f:type/@value=('group', 'display') and f:*[starts-with(local-name(.), 'initial')]) | |
| inv-11 | Questionnaire.item.extension | Display category can only be specified for items of type display XPath: parent::*/f:type/@value='display' | |
| inv-11 | Questionnaire.item.extension | Display category can only be specified for items of type display XPath: parent::*/f:type/@value='display' | |
| inv-11 | Questionnaire.item.extension | Display category can only be specified for items of type display XPath: parent::*/f:type/@value='display' | |
| inv-11 | Questionnaire.item.extension | Display category can only be specified for items of type display XPath: parent::*/f:type/@value='display' | |
| inv-11 | Questionnaire.item.extension | Display category can only be specified for items of type display XPath: parent::*/f:type/@value='display' | |
| inv-11 | Questionnaire.item.extension | Display category can only be specified for items of type display XPath: parent::*/f:type/@value='display' | |
| inv-11 | Questionnaire.item.extension | Display category can only be specified for items of type display XPath: parent::*/f:type/@value='display' | |
| inv-11 | Questionnaire.item.extension | Display category can only be specified for items of type display XPath: parent::*/f:type/@value='display' | |
| inv-11 | Questionnaire.item.extension | Display category can only be specified for items of type display XPath: parent::*/f:type/@value='display' | |
| inv-11 | Questionnaire.item.extension | Display category can only be specified for items of type display XPath: parent::*/f:type/@value='display' | |
| inv-11 | Questionnaire.item.extension | Display category can only be specified for items of type display XPath: parent::*/f:type/@value='display' | |
| inv-11 | Questionnaire.item.extension | Display category can only be specified for items of type display XPath: parent::*/f:type/@value='display' | |
| inv-11 | Questionnaire.item.extension | Display category can only be specified for items of type display XPath: parent::*/f:type/@value='display' | |
| inv-11 | Questionnaire.item.extension | Display category can only be specified for items of type display XPath: parent::*/f:type/@value='display' | |
| inv-11 | Questionnaire.item.extension | Display category can only be specified for items of type display XPath: parent::*/f:type/@value='display' | |
| inv-11 | Questionnaire.item.extension | Display category can only be specified for items of type display XPath: parent::*/f:type/@value='display' | |
| inv-11 | Questionnaire.item.extension | Display category can only be specified for items of type display XPath: parent::*/f:type/@value='display' | |
| inv-11 | Questionnaire.item.extension | Display category can only be specified for items of type display XPath: parent::*/f:type/@value='display' | |
| inv-11 | Questionnaire.item.extension | Display category can only be specified for items of type display XPath: parent::*/f:type/@value='display' | |
| que-7 | Questionnaire.item.enableWhen | enableWhen must contain either an 'answer' or an 'answered' element XPath: count(*[starts-with(local-name(.), 'answer')]|answered) = 1 |
© HL7.org 2011+. FHIR STU3 Candidate (v1.4.0-8139) generated on Thu, Mar 31, 2016 08:10+1100. QA Page
Links: Search |
Version History |
Table of Contents |
Compare to DSTU2 |
|
Propose a change